Skip to content

docs: proof-reading the tutorial #2636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 27, 2025

Conversation

ulidtko
Copy link
Contributor

@ulidtko ulidtko commented Mar 3, 2025

Hi, Agda team!

Here's a small patch in the tutorial, doc/README*, with minor editorials: typos and the like.

I know it's always easier for (somebody else's) fresh set of eyeballs to do proof-reads. Thus, here goes.

Hoping for easy merge — there's no code change, just the docstrings.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@ulidtko
Copy link
Contributor Author

ulidtko commented Mar 3, 2025

BTW @andreasabel, thanks for reminding me!

This has been collecting dust for... turns out, exactly a year. I was initially meaning to go over all readme modules; alas, that hadn't happened. Uneasy times.

Copy link
Contributor

@JacquesCarette JacquesCarette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wish I could do a 'request clarification' review. Basically this all looks good to me (but I'll want a second pair of eyes), except for the one thing that I comment on.

Copy link
Contributor

@jamesmckinna jamesmckinna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for offering this. I think it would be good to nail down the discussion with @Taneb before merging, though.

Copy link
Contributor

@jamesmckinna jamesmckinna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest rewriting (rather than deleting) the paragraph in favour of (some version of) the suggestion below.
Either that, or reinstate the paragraph and we can have another go as a separate PR (but that seems 'wasteful', given that the one at hand already problematises the paragraph as needing fixing in some for or another...)

@jamesmckinna
Copy link
Contributor

Six weeks later, let me ask explicitly again for comments on my proposed rephrasing...
@Taneb @MatthewDaggitt @gallais

@MatthewDaggitt MatthewDaggitt added this to the v2.3 milestone May 26, 2025
Co-authored-by: jamesmckinna <31931406+jamesmckinna@users.noreply.github.com>
@MatthewDaggitt
Copy link
Contributor

Sorry for the long reply time, yes that rephrasing sounds fine to me @jamesmckinna, thanks for suggesting!

@jamesmckinna
Copy link
Contributor

Thanks @MatthewDaggitt ... paragraph (tweaked) now committed.

@jamesmckinna jamesmckinna dismissed their stale review May 27, 2025 07:10

I've now committed my originally suggested paragraph, with some subsequent (typographic) tweaks

@jamesmckinna
Copy link
Contributor

If one of us can (re-)read what is now there, suggest we merge?

@MatthewDaggitt
Copy link
Contributor

Thanks for the tweaks @ulidtko and @jamesmckinna, merging in now.

@MatthewDaggitt MatthewDaggitt added this pull request to the merge queue May 27, 2025
Merged via the queue into agda:master with commit ac6571b May 27, 2025
12 checks passed
@ulidtko ulidtko deleted the docs/proofread-readme branch May 28, 2025 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants